Breaking Changes

On this page:

Configuration Manager

BREAKING CHANGE for 2020.1 -> 2020.2

The following are breaking changes for the 2020.2 release.

API changes and requirements for Jinja2 integration into Golden Configuration

The updateConfigSpec and createConfigSpec APIs in Configuration Manager have been updated to support Jinja2 integration. Since they now take a different payload, users will need to run the following.

  1. Run the migration script migrate_to_jinja in the migration_scripts directory of Configuration Manager.

  2. The updateConfigSpec and createConfigSpec methods/APIs now require the second parameter to be data instead of lines.

    Example

    {
        "deviceType": "cisco-ios",
        "data": {
            "template": "hostname {{hostname}}\ninterface gigabitethernet 0/1\n ip address {{ipAddress}}",
            "variables": [
                {
                    "name": "hostname",
                    "type": "literal",
                    "value": "itential"
                },
                {
                    "name": "ipAddress",
                    "type": "literal",
                    "value": "192.168.12.2"
                }
            ]
        }
    }

API removal due to scheduled deprecations

The table below shows a list of APIs that have been removed from IAP. Our policy is to provide a deprecation notice two (2) release cycles in advance (at a minimum) before the API is removed. This list represents all deprecations announced in the 2019.3 release.

What should I do?

Review any custom apps and adapters that might reference any APIs on the list and change them to the replacement call (or remove them if no replacement call is given.)

Removed APIs

Item Description Deprecation Release Actual Removal Release Replacement
API: {POST} /deviceGroups
WF Task: createDeviceGroups
API for creating a device group. 2019.3 2020.2 API: {POST} /deviceGroup
WF Task: createDeviceGroup